home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / vltbrk33.zip / VLTBRK.DOC < prev    next >
Text File  |  1991-04-21  |  11KB  |  293 lines
  1.  
  2.     Page 1
  3.                        Vault Breaker Door v3.3
  4.                             by: Terry West
  5.              Sysop, The Strawberry Patch BBS 606-432-0879
  6.  
  7.  
  8.     Version 3.3 release date: 04/21/91
  9.  
  10.     About this documentation:
  11.     -------------------------
  12.  
  13.     My apologies for the lousy documentation, but I never once claimed
  14.     to be an author. If you encounter any difficulties setting up this
  15.     door, please don't hesitate to call my BBS and leave me a message.
  16.     I'll do my very best to help if I can.
  17.  
  18.     What is Vault Breaker?
  19.     ----------------------
  20.  
  21.     Vault Breaker is a ProKit based game door for PCBoard v14.5 that
  22.     allows a user to attempt to break the system's vault. If he
  23.     or she breaks the vault, they win a SysOp configurable prize.
  24.  
  25.     Support
  26.     -------
  27.  
  28.     The latest version of the Vault Breaker door can always be found
  29.     on the Strawberry Patch BBS. The number is 606-432-0879. Instant
  30.     online registration via the InstaReg Door. No waiting, download
  31.     on your first call. Additional time/privileges for visiting
  32.     SysOps. Node 1 is equiped with a HST dual standard.
  33.  
  34.     Features
  35.     --------
  36.  
  37.     * SysOp Configurable Combination:
  38.  
  39.     Vault Breaker generates a random combination each time the door
  40.     is opened. The upper limit of the combination is set by the
  41.     SysOp. You can make the vault either easy, moderate, or hard
  42.     to break. The maximum number for the combination is 99. If you
  43.     prefer a "fixed" combination, use any ASCII editor and create a
  44.     file called VLTBRK.CMB as follows:
  45.  
  46.     Line 1: Combination Digit 1
  47.     Line 2: Combination Digit 2
  48.     Line 3: Combination Digit 3
  49.  
  50.     Note: the maximun number for the combination is still 99 even
  51.     if you use the VLTBRK.CMB file. It would also be advisable to
  52.     set the door up to LOCK after a user breaks the vault when using
  53.     a fixed combination instead of a random one.
  54.  
  55.     * SysOp Configurable Door Lock:
  56.  
  57.     By setting a switch in the .CNF file, the door will automatically
  58.     shut down after a user breaks the vault. The door will generate a
  59.     file called VLTBRK.LCK in the door directory. The door will
  60.     inform other users that the prize has already been awarded and ask
  61.     that they try again tomorrow. At that point they will be returned
  62.     to PCBoard. The door will remain locked until such time as you
  63.     delete the VLTBRK.LCK file.
  64.  
  65.  
  66.     Page 2
  67.  
  68.     * SysOp Configurable "hint" feature:
  69.  
  70.     By setting a switch in the .CNF file you can have the door inform
  71.     a user if each digit entered was either too high, too low, or
  72.     right. Use this feature wisely!
  73.  
  74.     * SysOp Configurable number of attempts
  75.  
  76.     The SysOp may also select the number of tries a user gets per
  77.     session to break the vault. The minimum number is 3 and the maximum
  78.     number is 6. Each new attempt will have a new combination.
  79.  
  80.     * SysOp Configurable "Help" screen.
  81.  
  82.     * SysOp Configurable Online Time Award:
  83.  
  84.     Vault Breaker will optionally award users with online time on a
  85.     random basis in the SysOp so desires.
  86.  
  87.     * SysOp Configurable Security/Expiration Date Adjustment
  88.  
  89.     If a user breaks the Vault, the door will look for the existance of
  90.     a file called VLTBRK.ADJ and if it exists, the door will update the
  91.     user's security level and expiration date according to the parameters
  92.     in the the file. The VLTBRK.ADJ should be in the following format:
  93.  
  94.     Line 1. Number of days to increase user's expiration date
  95.     Line 2. Security level to assign user.
  96.  
  97.     The following example would increase the user's expiration date by one
  98.     year and assign them a level 71 security:
  99.  
  100.     365
  101.     71
  102.  
  103.     Please note, this feature is available ONLY in the registered
  104.     version and is disabled if the file VLTBRK.ADJ doesn't exist.
  105.  
  106.  
  107.     * Full logging:
  108.  
  109.     In addition to writing entries to the caller's log, the  door also
  110.     writes out a file containing the names and time that the  vault was
  111.     broken. This file is configurable, so you could use it as a bulletin
  112.     or for your own records. Note: this file is contains the @Xhh color
  113.     macros, so it'll look a bit strange it you simply "type" it.
  114.  
  115.     * Graphics check:
  116.  
  117.     Since Vault Breaker relies heavily on ANSI graphics, any user
  118.     attempting to open the door while in the non-graphics mode will be
  119.     asked if they wish to continue. If not they're returned to PCBoard.
  120.     If they choose to continue, the graphics mode will be enabled until
  121.     they return to PCBoard.
  122.  
  123.  
  124.     Page 3
  125.  
  126.     * SysOp configurable "maximum security level allowed to use door":
  127.  
  128.     The SysOp can enter a maximum security level allowed in the .CNF
  129.     file. If a user's security level is higher than that specified,
  130.     he/she will be notified via the file VLTBRK.MAX and returned to
  131.     PCBoard. Level 120 is excluded. This feature can be disabled by
  132.     setting the level to 0.
  133.  
  134.     * Full comm port monitoring:
  135.  
  136.     Vault Breaker uses the highly reliable ProKit routines for carrier
  137.     loss detection, etc.
  138.  
  139.     Files associated with the door's operation:
  140.  
  141.        ADOPT.DAT  : Adopt-a-door information screen
  142.        MAKECNF.EXE: the configuration file generator.
  143.        VLTBRK     : the door batch file (explained below).
  144.        VLTBRK.ADJ : optional file containing new expiration date/security
  145.                     level for user that breaks the vault (registered
  146.                     version only).
  147.        VLTBRK.BRK : optional file displayed to user that breaks the vault.
  148.        VLTBRK.CMB : optional "fixed" combination file (1 digit per line).
  149.        VLTBRK.CNF : the configuration file (explained below).
  150.      # VLTBRK.DAT : the door's user file.
  151.        VLTBRK.DOC : you're looking at it.
  152.        VLTBRK.EXE : the door program.
  153.        VLTBRK.HLP : displayed when a user selects the (I) menu option.
  154.      # VLTBRK.LCK : file generated after a user breaks the vault if
  155.                     the sysop has the "LOCK" option enabled.
  156.        VLTBRK.MAX : displayed to user with security level higher than allowed.
  157.        VLTBRK.SCR : displayed when a user selects the (D) menu option.
  158.        VLTBRK.SYS : encrypted registration file (not included).
  159.  
  160.      # denotes a file generated by the door and not included in this zip.
  161.  
  162.     Setup:
  163.     ------
  164.  
  165.     UnZip the contents of this zip file into your door directory. I use
  166.     a separate directory for each door, so mine resides in the \VAULT
  167.     directory. After reviewing the documentation to get a grasp on how
  168.     you what to set the door up for your system, run the program MAKECNF.
  169.  
  170.  
  171.  
  172.     Page 4
  173.  
  174.     The VLTBKR.CNF file:
  175.     --------------------
  176.  
  177.     INTERRUPT
  178.     A 1 year subscription
  179.     30
  180.     15
  181.     3
  182.     BREAKERS
  183.     N
  184.     Y
  185.     0
  186.     No One Yet!
  187.  
  188.  
  189.     Line 1.  Communications driver: (INTERRUPT, BIOS, HANDSHAKE)
  190.     Line 2.  Your Prize. (62 characters or less).
  191.     Line 3.  Amount of online time to randomly award (0 to disable).
  192.     Line 4.  Maximum number for combination (99 max.)
  193.     Line 5.  Maximum number of trys per session (min. 3 - max. 6)
  194.     Line 6.  File to write winner's name to.
  195.     Line 7.  Lock door if vault is broken (Y/N)
  196.     Line 8.  Give user higher/lower hint (Y/N)
  197.     Line 9.  Maximum level allowed in door (120 excluded) (0 to disable)
  198.     Line 10. Last user to break the vault
  199.  
  200.     The VLTBRK door batch file:
  201.     ---------------------------
  202.  
  203.     @Echo Off
  204.     Cd\Vault
  205.     VltBrk VltBrk.Cnf C:\Pcb
  206.     Cd\Pcb
  207.     If Exist Event.Bat Event
  208.     Board
  209.  
  210.     Line 1. Sets the local echo to off (do not use the @ if you're using
  211.             a version of DOS earlier than 3.3.
  212.  
  213.     Line 2. Switches to the directory containing the Vault Breaker files.
  214.  
  215.     Line 3. Starts Vault Breaker with the vltbrk.cnf configuration file.
  216.             The C:\Pcb is the location of the PCBoard.Dat file for this
  217.             node.
  218.  
  219.     Line 4. Switches back to the Pcb directory for this node.
  220.  
  221.     Line 5. Runs the event if needed.
  222.  
  223.     Line 6. Restarts PCBoard.
  224.  
  225.  
  226.     Optional:
  227.  
  228.     If you'd like for users to be able to play more than once per day, add
  229.     a line before line 3 like this:
  230.  
  231.     If Exists VltBrk.Dat Del VltBrk.Dat
  232.  
  233.     This will allow users to play as many times per day as they desire.
  234.  
  235.  
  236.     Page 5
  237.  
  238.     Registration:
  239.     -------------
  240.  
  241.     The Vault Breaker Door is released as ShareWare and is meant to be
  242.     used for no more than 30 days without being registered. After 30
  243.     days you are expected to either register the door or cease to use it.
  244.     To register your copy, send check or money order for $15 to:
  245.  
  246.     Terry West
  247.     P.O. Box 3171
  248.     Pikeville, Ky.
  249.     41502
  250.  
  251.     You'll then be able to download an encrypted registration file that
  252.     replaces the [Unregistered Evaluation Copy] with Registered to: Your
  253.     Board name. The registration file will work with ALL future releases
  254.     of Vault Breaker. If you'd like for me to upload your VLTBRK.SYS file,
  255.     please include an extra $1. (US ONLY!) Set up an account on your BBS
  256.     in the name of Terry West and let me know what the password is.
  257.  
  258.     Please Note: Unregistered copies of this door will cease to function
  259.     after 01/01/92.
  260.  
  261.     Disclaimer
  262.     ----------
  263.  
  264.     I make no warranty of any kind, express or implied, including without
  265.     limitation, any warranties of merchantability and/or fitness for a
  266.     particular purpose.  I shall not be liable for any damages, whether
  267.     direct, indirect, special or consequential arising from a failure of
  268.     this program to operate in the manner desired by the user.  I shall not
  269.     be liable for any damage to data or property which may be caused
  270.     directly or indirectly by the use of this program.
  271.  
  272.     IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST
  273.     PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
  274.     ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY
  275.     CLAIM BY ANY OTHER PARTY.
  276.  
  277.     PCBoard is a registered trademark of Clark Development Company.
  278.     ProKit is copyrighted by Samuel Smith.
  279.     InstaReg is copyrighted by Don Cheeks and Lana Fox.
  280.  
  281.  
  282.     Beta Testers:
  283.     -------------
  284.  
  285.     Special thanks to the following people who put up with my many beta
  286.     releases and were most helpful in squashing the bugs:
  287.  
  288.     Fred McClaren       True Blue BBS    (314) 434-1378 Hayes v32
  289.     Charles Baldridge   AdventureComm    (606) 789-3423 HST 964
  290.  
  291.     Be sure to check out these 2 bbs's, as both are first class systems.
  292.  
  293.